Google Calendar

Visier can retrieve data through this connector if the following requirements are met.

Prerequisites

  • Create an OAuth 2.0 Client in Google Cloud Console.

OAuth 2.0 client application

Create OAuth 2.0 credentials for a web application in Google Cloud Console and assign it the appropriate security access so that Visier can retrieve your source data.

  1. Go to Google Cloud Console and sign in using the Google account that will administer the Google Calendar connector web application and manage the enabled APIs.
  2. Select an existing project or create a new project for the integration.
  3. Go to APIs & Services > Library and enable the following APIs:
    • Google Calendar API
    • Google Admin SDK API
  4. Go to APIs > OAuth consent screen to configure the OAuth consent screen and choose scopes:
    1. Choose a user type:
      • Internal: Select this option only if all users of the app belong to the same Google Workspace domain as the project owner.
      • External: Select this option if users might sign in from outside yoru organization, including other Google Workspace domains or personal Gmail accounts.
    2. Fill in the app name, user support email, and developer contact email.

    3. Add the following scopes:

      Scope

      Description

      https://www.googleapis.com/auth/calendar.readonly

      See and download any calendar you can access using your Google Calendar.

      https://www.googleapis.com/auth/admin.directory.user.readonly

      See info about users on your domain.

      https://www.googleapis.com/auth/admin.directory.group.readonly

      View groups on your domain

    4. Click Save and continue until you reach the summary screen.
  5. Go to APIs & Services > Credentials to create the OAuth 2.0 client credentials:
    1. Click Create Credentials > OAuth client ID, and select Web application as the application type.
    2. Enter a client name such as Calendar Connector Web Client.
    3. Leave Authorized JavaScript origins blank.

    4. Under Authorized redirect URIs, add the following URI: https://{vanity_name}.visier.com/hr/provider/authRedirectSuccess

      Note:  

      • Replace {vanity_name} with the unique identifier for your tenant. You can find the vanity name in your Visier URL; for example, if your Visier URL is jupiter.visier.com, your tenant vanity name is jupiter. Ensure, the redirect URI is an correct, otherwise you may get a redirect_uri_mismatch error from Google.
      • It may take 5 minutes to a few hours for redirect URI changes to take effect

    5. Click Create to generate the client ID and secret.

  6. Copy the client ID and client secret, as you will need to provide the credentials in Visier.

Connector credentials

You need to input the following credentials into Visier so that we can retrieve data from your source system. To provide your credentials in Visier, see Set Up Data Connectors.

Ensure Custom is selected as the Application when setting up the connector credential.

Credential

Description

Example

Domain name

The domain name of your organization's Google Workspace.

bluth-development.com

Client ID

The unique identifier of the client application you created.

123456789012-abcdefghijklmnop.apps.googleusercontent.com

Client Secret

The client secret of the client application you created.

GOCSPX-abcdefghijklmnopqrstuvwxyz123456

Data files

The Google Calendar data connector retrieves the following data files:

  • NewAndUpdatedEvents: Calendar events that are new or have been updated since the last extraction, including details such as title, description, start and end times, location, organizer, recurrence patterns, and calendar ID.
  • NewAndUpdatedEventAttendees: Attendee information for events that are new or have been updated since the last extraction, including details such as attendee email addresses, names and response status (accepted/declined/tentative).

The following data files are not supported:

  • FutureEvents: Calendar events scheduled for future dates.
  • FutureEventAttendees: Attendee information for future events.
  • HistoricalEvents: Past calendar events from previous extractions.
  • HistoricalEventAttendees: Attendee information for historical events.

How the connector loads data

Initially, data connectors retrieve a full history for each subject to generate an initial history of events. In each subsequent data retrieval, each connector handles the data load differently.

  • Full load: All data from the source system is loaded into Visier.
  • Delta load: Only changed data is loaded into Visier. A delta load may take either the entire history or a specific number of years of history for each changed record.
  • Snapshot load: All data at a particular point in time. A snapshot load does not contain historical records or show changes over time.
  • Partial load: A subset of data is loaded into Visier.

The connector performs a full load during the initial extraction to establish a comprehensive baseline of historical calendar data. After the initial load, this connector only retrieves events that are new or have been updated since the last extraction. The connector uses the lastExtractionTime to filter events, only retrieving changes since the previous extraction. This lastExtractionTime can be overridden to extract data further back in time.

Privacy and visibility

When a calendar event is set to private, the connector applies a business rule that hides the event title and description to protect user privacy, while keeping the event in the data for analysis.